{ "opencollection": "1.0.0", "info": { "name": "APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Projects API", "version": "1.0.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Projects", "type": "folder" }, "items": [ { "info": { "name": "APIs.io Engineering Platform List organization projects", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/orgs/:org/projects", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "state", "value": "", "type": "query", "description": "Indicates the state of the projects to return." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned." }, { "info": { "name": "APIs.io Engineering Platform Create an organization project", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/orgs/:org/projects", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an organization project board. Returns a `410 Gone` status if projects are disabled in the organization or if the organization does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned." }, { "info": { "name": "APIs.io Engineering Platform Get a project card", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/projects/columns/cards/:card_id", "params": [ { "name": "card_id", "value": "", "type": "path", "description": "The unique identifier of the card." } ] }, "docs": "Gets information about a project card." }, { "info": { "name": "APIs.io Engineering Platform Update an existing project card", "type": "http" }, "http": { "method": "PATCH", "url": "http://apigateway.{region}.amazonaws.com/projects/columns/cards/:card_id", "params": [ { "name": "card_id", "value": "", "type": "path", "description": "The unique identifier of the card." } ], "body": { "type": "json", "data": "{}" } }, "docs": "APIs.io Engineering Platform Update an existing project card" }, { "info": { "name": "APIs.io Engineering Platform Delete a project card", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/projects/columns/cards/:card_id", "params": [ { "name": "card_id", "value": "", "type": "path", "description": "The unique identifier of the card." } ] }, "docs": "Deletes a project card" }, { "info": { "name": "APIs.io Engineering Platform Move a project card", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/projects/columns/cards/:card_id/moves", "params": [ { "name": "card_id", "value": "", "type": "path", "description": "The unique identifier of the card." } ], "body": { "type": "json", "data": "{}" } }, "docs": "APIs.io Engineering Platform Move a project card" }, { "info": { "name": "APIs.io Engineering Platform Get a project column", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/projects/columns/:column_id", "params": [ { "name": "column_id", "value": "", "type": "path", "description": "The unique identifier of the column." } ] }, "docs": "Gets information about a project column." }, { "info": { "name": "APIs.io Engineering Platform Update an existing project column", "type": "http" }, "http": { "method": "PATCH", "url": "http://apigateway.{region}.amazonaws.com/projects/columns/:column_id", "params": [ { "name": "column_id", "value": "", "type": "path", "description": "The unique identifier of the column." } ], "body": { "type": "json", "data": "{}" } }, "docs": "APIs.io Engineering Platform Update an existing project column" }, { "info": { "name": "APIs.io Engineering Platform Delete a project column", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/projects/columns/:column_id", "params": [ { "name": "column_id", "value": "", "type": "path", "description": "The unique identifier of the column." } ] }, "docs": "Deletes a project column." }, { "info": { "name": "APIs.io Engineering Platform List project cards", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/projects/columns/:column_id/cards", "params": [ { "name": "column_id", "value": "", "type": "path", "description": "The unique identifier of the column." }, { "name": "archived_state", "value": "", "type": "query", "description": "Filters the project cards that are returned by the card's state." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the project cards in a project." }, { "info": { "name": "APIs.io Engineering Platform Create a project card", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/projects/columns/:column_id/cards", "params": [ { "name": "column_id", "value": "", "type": "path", "description": "The unique identifier of the column." } ], "body": { "type": "json", "data": "{}" } }, "docs": "APIs.io Engineering Platform Create a project card" }, { "info": { "name": "APIs.io Engineering Platform Move a project column", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/projects/columns/:column_id/moves", "params": [ { "name": "column_id", "value": "", "type": "path", "description": "The unique identifier of the column." } ], "body": { "type": "json", "data": "{}" } }, "docs": "APIs.io Engineering Platform Move a project column" }, { "info": { "name": "APIs.io Engineering Platform Get a project", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/projects/:project_id", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The unique identifier of the project." } ] }, "docs": "Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned." }, { "info": { "name": "APIs.io Engineering Platform Update a project", "type": "http" }, "http": { "method": "PATCH", "url": "http://apigateway.{region}.amazonaws.com/projects/:project_id", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The unique identifier of the project." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned." }, { "info": { "name": "APIs.io Engineering Platform Delete a project", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/projects/:project_id", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The unique identifier of the project." } ] }, "docs": "Deletes a project board. Returns a `404 Not Found` status if projects are disabled." }, { "info": { "name": "APIs.io Engineering Platform List project collaborators", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/projects/:project_id/collaborators", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The unique identifier of the project." }, { "name": "affiliation", "value": "", "type": "query", "description": "Filters the collaborators by their affiliation. `outside` means outside collaborators of a project that are not a member of the project's organization. `direct` means collaborators with permissions to a project, regardless of organization membership status. `all` means all collaborators the authenticated user can see." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators." }, { "info": { "name": "APIs.io Engineering Platform Add project collaborator", "type": "http" }, "http": { "method": "PUT", "url": "http://apigateway.{region}.amazonaws.com/projects/:project_id/collaborators/:username", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The unique identifier of the project." }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator." }, { "info": { "name": "APIs.io Engineering Platform Remove user as a collaborator", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/projects/:project_id/collaborators/:username", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The unique identifier of the project." }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator." }, { "info": { "name": "APIs.io Engineering Platform Get project permission for a user", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/projects/:project_id/collaborators/:username/permission", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The unique identifier of the project." }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level." }, { "info": { "name": "APIs.io Engineering Platform List project columns", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/projects/:project_id/columns", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The unique identifier of the project." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the project columns in a project." }, { "info": { "name": "APIs.io Engineering Platform Create a project column", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/projects/:project_id/columns", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The unique identifier of the project." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new project column." }, { "info": { "name": "APIs.io Engineering Platform List repository projects", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/repos/:owner/:repo/projects", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "state", "value": "", "type": "query", "description": "Indicates the state of the projects to return." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned." }, { "info": { "name": "APIs.io Engineering Platform Create a repository project", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/repos/:owner/:repo/projects", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a repository project board. Returns a `410 Gone` status if projects are disabled in the repository or if the repository does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned." }, { "info": { "name": "APIs.io Engineering Platform Create a user project", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/user/projects", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a user project board. Returns a `410 Gone` status if the user does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned." }, { "info": { "name": "APIs.io Engineering Platform List user projects", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/users/:username/projects", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." }, { "name": "state", "value": "", "type": "query", "description": "Indicates the state of the projects to return." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists projects for a user." } ] } ], "bundled": true }