ecosyste-ms-cli 1.3.2__py3-none-any.whl

ecosystems_cli/apis/issues.openapi.yaml

@@ -0,0 +1,839 @@
+---
+openapi: 3.0.1
+info:
+  title: 'Ecosyste.ms: issues'
+  description: 'An open API service providing issue metadata for open source projects. '
+  contact:
+    name: Ecosyste.ms
+    email: support@ecosyste.ms
+    url: https://ecosyste.ms
+  version: 1.0.0
+  license:
+    name: CC-BY-SA-4.0
+    url: https://creativecommons.org/licenses/by-sa/4.0/
+externalDocs:
+  description: GitHub Repository
+  url: https://github.com/ecosyste-ms/issues
+servers:
+- url: https://issues.ecosyste.ms/api/v1
+paths:
+  "/repositories/lookup":
+    get:
+      summary: Lookup repository metadata
+      operationId: repositoriesLookup
+      parameters:
+      - name: url
+        in: query
+        description: The URL of the repository to lookup
+        required: true
+        schema:
+          type: string
+      responses:
+        200:
+          description: OK
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Repository"
+  "/hosts":
+    get:
+      summary: list registies
+      operationId: getRegistries
+      parameters:
+      - name: page
+        in: query
+        description: pagination page number
+        required: false
+        schema:
+          type: integer
+      - name: per_page
+        in: query
+        description: Number of records to return
+        required: false
+        schema:
+          type: integer
+      responses:
+        200:
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  "$ref": "#/components/schemas/Host"
+  "/hosts/{hostName}":
+    get:
+      summary: get a host by name
+      operationId: getHost
+      parameters:
+      - in: path
+        name: hostName
+        schema:
+          type: string
+        required: true
+        description: name of host
+      responses:
+        200:
+          description: OK
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Host"
+  "/hosts/{hostName}/repositories":
+    get:
+      summary: get a list of repositories from a host
+      operationId: getHostRepositories
+      parameters:
+      - in: path
+        name: hostName
+        schema:
+          type: string
+        required: true
+        description: name of host
+      - name: page
+        in: query
+        description: pagination page number
+        required: false
+        schema:
+          type: integer
+      - name: per_page
+        in: query
+        description: Number of records to return
+        required: false
+        schema:
+          type: integer
+      - name: created_after
+        in: query
+        description: filter by created_at after given time
+        required: false
+        schema:
+          type: string
+          format: date-time
+      - name: updated_after
+        in: query
+        description: filter by updated_at after given time
+        required: false
+        schema:
+          type: string
+          format: date-time
+      - name: sort
+        in: query
+        description: field to order results by
+        required: false
+        schema:
+          type: string
+      - name: order
+        in: query
+        description: direction to order results by
+        required: false
+        schema:
+          type: string
+      responses:
+        200:
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  "$ref": "#/components/schemas/Repository"
+  "/hosts/{hostName}/repositories/{repoName}":
+    get:
+      summary: get a repository from a host
+      operationId: getHostRepository
+      parameters:
+      - in: path
+        name: hostName
+        schema:
+          type: string
+        required: true
+        description: name of host
+      - in: path
+        name: repoName
+        schema:
+          type: string
+        required: true
+        description: name of repository
+      responses:
+        200:
+          description: OK
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Repository"
+  "/hosts/{hostName}/repositories/{repoName}/issues":
+    get:
+      summary: get a list of issues from a repository
+      operationId: getHostRepositoryIssues
+      parameters:
+      - in: path
+        name: hostName
+        schema:
+          type: string
+        required: true
+        description: name of host
+      - in: path
+        name: repoName
+        schema:
+          type: string
+        required: true
+        description: name of repository
+      - name: page
+        in: query
+        description: pagination page number
+        required: false
+        schema:
+          type: integer
+      - name: per_page
+        in: query
+        description: Number of records to return
+        required: false
+        schema:
+          type: integer
+      - name: created_after
+        in: query
+        description: filter by created_at after given time
+        required: false
+        schema:
+          type: string
+          format: date-time
+      - name: updated_after
+        in: query
+        description: filter by updated_at after given time
+        required: false
+        schema:
+          type: string
+          format: date-time
+      - name: sort
+        in: query
+        description: field to order results by
+        required: false
+        schema:
+          type: string
+      - name: order
+        in: query
+        description: direction to order results by
+        required: false
+        schema:
+          type: string
+      - name: pull_request
+        in: query
+        description: filter by if it's a pull request
+        required: false
+        schema:
+          type: boolean
+      - name: state
+        in: query
+        description: filter by issue state (open, closed)
+        required: false
+        schema:
+          type: string
+      - name: label
+        in: query
+        description: filter by label name
+        required: false
+        schema:
+          type: string
+      responses:
+        200:
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  "$ref": "#/components/schemas/Issue"
+  "/hosts/{hostName}/repositories/{repoName}/issues/{issueNumber}":
+    get:
+      summary: get an issue from a repository
+      operationId: getHostRepositoryIssue
+      parameters:
+      - in: path
+        name: hostName
+        schema:
+          type: string
+        required: true
+        description: name of host
+      - in: path
+        name: repoName
+        schema:
+          type: string
+        required: true
+        description: name of repository
+      - in: path
+        name: issueNumber
+        schema:
+          type: integer
+        required: true
+        description: number of issue
+      responses:
+        200:
+          description: OK
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Issue"
+  "/hosts/{hostName}/repositories/{repoName}/labels":
+    get:
+      summary: get a list of labels used in issues for a repository
+      operationId: getHostRepositoryLabels
+      parameters:
+      - in: path
+        name: hostName
+        schema:
+          type: string
+        required: true
+        description: name of host
+      - in: path
+        name: repoName
+        schema:
+          type: string
+        required: true
+        description: name of repository
+      responses:
+        200:
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  "$ref": "#/components/schemas/LabelCount"
+  "/hosts/{hostName}/owners":
+    get:
+      summary: get a list of owners from a host
+      operationId: getHostOwners
+      parameters:
+      - in: path
+        name: hostName
+        schema:
+          type: string
+        required: true
+        description: name of host
+      - name: page
+        in: query
+        description: pagination page number
+        required: false
+        schema:
+          type: integer
+      - name: per_page
+        in: query
+        description: Number of records to return
+        required: false
+        schema:
+          type: integer
+      responses:
+        200:
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  "$ref": "#/components/schemas/OwnerSummary"
+  "/hosts/{hostName}/owners/{ownerName}":
+    get:
+      summary: get owner statistics from a host
+      operationId: getHostOwner
+      parameters:
+      - in: path
+        name: hostName
+        schema:
+          type: string
+        required: true
+        description: name of host
+      - in: path
+        name: ownerName
+        schema:
+          type: string
+        required: true
+        description: name of owner
+      responses:
+        200:
+          description: OK
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Owner"
+  "/hosts/{hostName}/owners/{ownerName}/maintainers":
+    get:
+      summary: get maintainers for an owner
+      operationId: getHostOwnerMaintainers
+      parameters:
+      - in: path
+        name: hostName
+        schema:
+          type: string
+        required: true
+        description: name of host
+      - in: path
+        name: ownerName
+        schema:
+          type: string
+        required: true
+        description: name of owner
+      responses:
+        200:
+          description: OK
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Maintainers"
+  "/hosts/{hostName}/authors":
+    get:
+      summary: get a list of authors from a host
+      operationId: getHostAuthors
+      parameters:
+      - in: path
+        name: hostName
+        schema:
+          type: string
+        required: true
+        description: name of host
+      - name: page
+        in: query
+        description: pagination page number
+        required: false
+        schema:
+          type: integer
+      - name: per_page
+        in: query
+        description: Number of records to return
+        required: false
+        schema:
+          type: integer
+      responses:
+        200:
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  "$ref": "#/components/schemas/AuthorSummary"
+  "/hosts/{hostName}/authors/{authorName}":
+    get:
+      summary: get author statistics from a host
+      operationId: getHostAuthor
+      parameters:
+      - in: path
+        name: hostName
+        schema:
+          type: string
+        required: true
+        description: name of host
+      - in: path
+        name: authorName
+        schema:
+          type: string
+        required: true
+        description: username of author
+      responses:
+        200:
+          description: OK
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Author"
+  "/jobs":
+    post:
+      summary: create a job to sync issues from a URL
+      operationId: createJob
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                url:
+                  type: string
+                  description: URL of the repository to sync issues from
+              required:
+              - url
+      responses:
+        302:
+          description: Redirect to the created job
+        400:
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  title:
+                    type: string
+                  details:
+                    type: array
+                    items:
+                      type: string
+  "/jobs/{jobId}":
+    get:
+      summary: get the status of a job
+      operationId: getJob
+      parameters:
+      - in: path
+        name: jobId
+        schema:
+          type: integer
+        required: true
+        description: ID of the job
+      responses:
+        200:
+          description: OK
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Job"
+components:
+  schemas:
+    Host:
+      type: object
+      properties:
+        name:
+          type: string
+        url:
+          type: string
+        kind:
+          type: string
+        repositories_count:
+          type: integer
+        issues_count:
+          type: integer
+        pull_requests_count:
+          type: integer
+        authors_count:
+          type: integer
+        last_synced_at:
+          type: string
+          format: date-time
+        icon_url:
+          type: string
+    Repository:
+      type: object
+      properties:
+        full_name:
+          type: string
+        html_url:
+          type: string
+        last_synced_at:
+          type: string
+          format: date-time
+        status:
+          type: string
+        issues_count:
+          type: integer
+        pull_requests_count:
+          type: integer
+        avg_time_to_close_issue:
+          type: number
+        avg_time_to_close_pull_request:
+          type: number
+        issues_closed_count:
+          type: integer
+        pull_requests_closed_count:
+          type: integer
+        pull_request_authors_count:
+          type: integer
+        issue_authors_count:
+          type: integer
+        avg_comments_per_issue:
+          type: number
+        avg_comments_per_pull_request:
+          type: number
+        merged_pull_requests_count:
+          type: integer
+        bot_issues_count:
+          type: integer
+        bot_pull_requests_count:
+          type: integer
+        past_year_issues_count:
+          type: integer
+        past_year_pull_requests_count:
+          type: integer
+        past_year_avg_time_to_close_issue:
+          type: number
+        past_year_avg_time_to_close_pull_request:
+          type: number
+        past_year_issues_closed_count:
+          type: integer
+        past_year_pull_requests_closed_count:
+          type: integer
+        past_year_pull_request_authors_count:
+          type: integer
+        past_year_issue_authors_count:
+          type: integer
+        past_year_avg_comments_per_issue:
+          type: number
+        past_year_avg_comments_per_pull_request:
+          type: number
+        past_year_merged_pull_requests_count:
+          type: integer
+        past_year_bot_issues_count:
+          type: integer
+        past_year_bot_pull_requests_count:
+          type: integer
+        updated_at:
+          type: string
+          format: date-time
+        created_at:
+          type: string
+          format: date-time
+        issues_url:
+          type: string
+    Issue:
+      type: object
+      properties:
+        uuid:
+          type: integer
+        number:
+          type: integer
+        node_id:
+          type: string
+        title:
+          type: string
+        user:
+          type: string
+        labels:
+          type: array
+          items:
+            type: string
+        assignees:
+          type: array
+          items:
+            type: string
+        comments_count:
+          type: integer
+        pull_request:
+          type: boolean
+        author_association:
+          type: string
+        state:
+          type: string
+        state_reason:
+          type: string
+        time_to_close:
+          type: integer
+        merged_at:
+          type: string
+          format: date-time
+        locked:
+          type: boolean
+        comments:
+          type: integer
+        created_at:
+          type: string
+          format: date-time
+        updated_at:
+          type: string
+          format: date-time
+        closed_at:
+          type: string
+          format: date-time
+        html_url:
+          type: string
+        url:
+          type: string
+    OwnerSummary:
+      type: object
+      properties:
+        login:
+          type: string
+        repositories_count:
+          type: integer
+        owner_url:
+          type: string
+    Owner:
+      type: object
+      properties:
+        login:
+          type: string
+        issues_count:
+          type: integer
+        pull_requests_count:
+          type: integer
+        merged_pull_requests_count:
+          type: integer
+        average_issue_close_time:
+          type: number
+        average_pull_request_close_time:
+          type: number
+        average_issue_comments_count:
+          type: number
+        average_pull_request_comments_count:
+          type: number
+        issue_repos:
+          type: array
+          items:
+            "$ref": "#/components/schemas/RepoCount"
+        pull_request_repos:
+          type: array
+          items:
+            "$ref": "#/components/schemas/RepoCount"
+        issue_author_associations_count:
+          type: array
+          items:
+            "$ref": "#/components/schemas/AuthorAssociationCount"
+        pull_request_author_associations_count:
+          type: array
+          items:
+            "$ref": "#/components/schemas/AuthorAssociationCount"
+        issue_labels_count:
+          type: array
+          items:
+            "$ref": "#/components/schemas/LabelCount"
+        pull_request_labels_count:
+          type: array
+          items:
+            "$ref": "#/components/schemas/LabelCount"
+        issue_authors:
+          type: array
+          items:
+            "$ref": "#/components/schemas/AuthorCount"
+        pull_request_authors:
+          type: array
+          items:
+            "$ref": "#/components/schemas/AuthorCount"
+        maintainers:
+          type: array
+          items:
+            "$ref": "#/components/schemas/MaintainerCount"
+        active_maintainers:
+          type: array
+          items:
+            "$ref": "#/components/schemas/MaintainerCount"
+    Maintainers:
+      type: object
+      properties:
+        login:
+          type: string
+        maintainers:
+          type: array
+          items:
+            "$ref": "#/components/schemas/MaintainerCount"
+        active_maintainers:
+          type: array
+          items:
+            "$ref": "#/components/schemas/MaintainerCount"
+    AuthorSummary:
+      type: object
+      properties:
+        login:
+          type: string
+        repositories_count:
+          type: integer
+        author_url:
+          type: string
+    Author:
+      type: object
+      properties:
+        login:
+          type: string
+        issues_count:
+          type: integer
+        pull_requests_count:
+          type: integer
+        merged_pull_requests_count:
+          type: integer
+        average_issue_close_time:
+          type: number
+        average_pull_request_close_time:
+          type: number
+        average_issue_comments_count:
+          type: number
+        average_pull_request_comments_count:
+          type: number
+        issue_repos:
+          type: array
+          items:
+            "$ref": "#/components/schemas/RepoCount"
+        pull_request_repos:
+          type: array
+          items:
+            "$ref": "#/components/schemas/RepoCount"
+        issue_author_associations_count:
+          type: array
+          items:
+            "$ref": "#/components/schemas/AuthorAssociationCount"
+        pull_request_author_associations_count:
+          type: array
+          items:
+            "$ref": "#/components/schemas/AuthorAssociationCount"
+        issue_labels_count:
+          type: array
+          items:
+            "$ref": "#/components/schemas/LabelCount"
+        pull_request_labels_count:
+          type: array
+          items:
+            "$ref": "#/components/schemas/LabelCount"
+        maintaining:
+          type: array
+          items:
+            "$ref": "#/components/schemas/RepoCount"
+        active_maintaining:
+          type: array
+          items:
+            "$ref": "#/components/schemas/RepoCount"
+    Job:
+      type: object
+      properties:
+        id:
+          type: integer
+        url:
+          type: string
+        status:
+          type: string
+        results:
+          type: object
+        created_at:
+          type: string
+          format: date-time
+        updated_at:
+          type: string
+          format: date-time
+        sidekiq_id:
+          type: string
+    RepoCount:
+      type: object
+      properties:
+        repository:
+          type: string
+        count:
+          type: integer
+        url:
+          type: string
+    AuthorAssociationCount:
+      type: object
+      properties:
+        author_association:
+          type: string
+        count:
+          type: integer
+    LabelCount:
+      type: object
+      properties:
+        label:
+          type: string
+        count:
+          type: integer
+        issues_url:
+          type: string
+    AuthorCount:
+      type: object
+      properties:
+        author:
+          type: string
+        count:
+          type: integer
+        url:
+          type: string
+    MaintainerCount:
+      type: object
+      properties:
+        maintainer:
+          type: string
+        count:
+          type: integer
+        url:
+          type: string