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

ecosystems_cli/apis/resolve.openapi.yaml

@@ -0,0 +1,130 @@
+---
+openapi: 3.0.1
+info:
+  title: 'Ecosyste.ms: Resolve'
+  description: An open API service to resolve dependency trees of packages for many
+    open source software ecosystems.
+  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/resolve
+servers:
+- url: https://resolve.ecosyste.ms/api/v1
+paths:
+  "/registries":
+    get:
+      summary: list available registries
+      operationId: listRegistries
+      responses:
+        200:
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  "$ref": "#/components/schemas/Registry"
+  "/jobs":
+    post:
+      summary: submit a resolve job
+      operationId: createJob
+      parameters:
+      - name: package_name
+        in: query
+        description: name of the package
+        required: true
+        schema:
+          type: string
+      - name: registry
+        in: query
+        description: name of the package registry, see /registries for available values
+        required: true
+        schema:
+          type: string
+      - name: before
+        in: query
+        description: resolve only with dependencies before this date
+        required: false
+        schema:
+          type: string
+          format: date-time
+      - name: version
+        in: query
+        description: resolve only with version within this range
+        required: false
+        schema:
+          type: string
+      responses:
+        301:
+          description: Redirect
+          headers:
+            location:
+              description: URL of submitted job
+              schema:
+                type: string
+  "/jobs/{jobID}":
+    get:
+      summary: fetch job by id
+      operationId: getJob
+      parameters:
+      - in: path
+        name: jobID
+        schema:
+          type: string
+        required: true
+        description: id of job
+      responses:
+        200:
+          description: OK
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Job"
+components:
+  schemas:
+    Registry:
+      type: object
+      properties:
+        name:
+          type: string
+        url:
+          type: string
+        ecosystem:
+          type: string
+        packages_count:
+          type: integer
+    Job:
+      type: object
+      properties:
+        id:
+          type: string
+        package_name:
+          type: string
+        registry:
+          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
+        sha256:
+          type: string
+        before:
+          type: string
+          format: date-time
+        version:
+          type: string

ecosystems_cli/apis/sbom.openapi.yaml

@@ -0,0 +1,79 @@
+---
+openapi: 3.0.1
+info:
+  title: 'Ecosyste.ms: SBOM'
+  description: An open API service to parse and convert between SBOM file formats.
+  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/sbom/by-sa/4.0/
+externalDocs:
+  description: GitHub Repository
+  url: https://github.com/ecosyste-ms/sbom
+servers:
+- url: https://sbom.ecosyste.ms/api/v1
+paths:
+  "/jobs":
+    post:
+      summary: submit a dependency parsing job
+      operationId: createJob
+      parameters:
+      - name: url
+        in: query
+        description: url of file or zip/tar archive
+        required: true
+        schema:
+          type: string
+      responses:
+        301:
+          description: Redirect
+          headers:
+            location:
+              description: URL of submitted job
+              schema:
+                type: string
+  "/jobs/{jobID}":
+    get:
+      summary: fetch job by id
+      operationId: getJob
+      parameters:
+      - in: path
+        name: jobID
+        schema:
+          type: string
+        required: true
+        description: id of job
+      responses:
+        200:
+          description: OK
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Job"
+components:
+  schemas:
+    Job:
+      type: object
+      properties:
+        id:
+          type: string
+        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
+        sha256:
+          type: string

ecosystems_cli/apis/sponsors.openapi.yaml

@@ -0,0 +1,283 @@
+---
+openapi: 3.0.1
+info:
+  title: 'Ecosyste.ms: Sponsors'
+  description: An open API service aggregating public data about GitHub Sponsors.
+  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/sponsors
+servers:
+- url: https://sponsors.ecosyste.ms/api/v1
+paths:
+  "/accounts":
+    get:
+      summary: List Accounts
+      description: List all maintainer accounts.
+      operationId: listAccounts
+      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: A list of accounts.
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  "$ref": "#/components/schemas/Account"
+        '404':
+          description: No accounts found.
+  "/accounts/{login}":
+    get:
+      summary: Get Account
+      description: Get an account by login.
+      operationId: getAccount
+      parameters:
+      - name: login
+        in: path
+        description: The login name for the account.
+        required: true
+        schema:
+          type: string
+      responses:
+        '200':
+          description: An account.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Account"
+        '404':
+          description: Account not found.
+  "/account/{login}/sponsors":
+    get:
+      summary: List Account Sponsors
+      description: List all sponsors for an account.
+      operationId: listAccountSponsors
+      parameters:
+      - name: login
+        in: path
+        description: The login name for the account.
+        required: true
+        schema:
+          type: string
+      - 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: A list of sponsors.
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  "$ref": "#/components/schemas/Sponsorship"
+        '404':
+          description: No sponsors found.
+  "/account/{login}/sponsorships":
+    get:
+      summary: List Account Sponsorships
+      description: List all sponsorships for an account.
+      operationId: listAccountSponsorships
+      parameters:
+      - name: login
+        in: path
+        description: The login name for the account.
+        required: true
+        schema:
+          type: string
+      - 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: A list of sponsorships.
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  "$ref": "#/components/schemas/Sponsorship"
+        '404':
+          description: No sponsorships found.
+  "/sponsors":
+    get:
+      summary: List Sponsors
+      description: List all sponsors.
+      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
+      operationId: listSponsors
+      responses:
+        '200':
+          description: A list of sponsors.
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  "$ref": "#/components/schemas/Account"
+        '404':
+          description: No sponsors found.
+components:
+  schemas:
+    Account:
+      required:
+      - id
+      - login
+      - has_sponsors_listing
+      - data
+      - created_at
+      - updated_at
+      - last_synced_at
+      - sponsors_count
+      - sponsorships_count
+      - active_sponsorships_count
+      - sponsor_profile
+      - url
+      - api_url
+      - html_url
+      - sponsors_url
+      - sponsors_api_url
+      - sponsorships_api_url
+      - minimum_sponsorship_amount
+      type: object
+      properties:
+        id:
+          type: integer
+          format: int64
+          description: The unique identifier for the account.
+        login:
+          type: string
+          description: The login name for the account.
+        has_sponsors_listing:
+          type: boolean
+          description: Indicates if the account has a sponsors listing.
+        data:
+          type: object
+          description: The raw data for the account.
+        created_at:
+          type: string
+          format: date-time
+          description: The date and time the account was created.
+        updated_at:
+          type: string
+          format: date-time
+          description: The date and time the account was last updated.
+        last_synced_at:
+          type: string
+          format: date-time
+          description: The date and time the account was last synced.
+        sponsors_count:
+          type: integer
+          format: int64
+          description: The number of sponsors for the account.
+        sponsorships_count:
+          type: integer
+          format: int64
+          description: The number of sponsorships for the account.
+        active_sponsorships_count:
+          type: integer
+          format: int64
+          description: The number of active sponsorships for the account.
+        sponsor_profile:
+          type: object
+          description: The sponsor profile for the account.
+        url:
+          type: string
+          description: The URL for the account.
+        api_url:
+          type: string
+          description: The API URL for the account.
+        html_url:
+          type: string
+          description: The HTML URL for the account.
+        sponsors_url:
+          type: string
+          description: The sponsors URL for the account.
+        sponsors_api_url:
+          type: string
+          description: The sponsors API URL for the account.
+        sponsorships_api_url:
+          type: string
+          description: The sponsorships API URL for the account.
+        minimum_sponsorship_amount:
+          type: integer
+          format: int64
+          description: The minimum sponsorship amount for the account.
+    Sponsorship:
+      required:
+      - id
+      - status
+      - created_at
+      - updated_at
+      - funder
+      - maintainer
+      type: object
+      properties:
+        id:
+          type: integer
+          format: int64
+          description: The unique identifier for the sponsorship.
+        status:
+          type: string
+          description: The status of the sponsorship.
+        created_at:
+          type: string
+          format: date-time
+          description: The date and time the sponsorship was created.
+        updated_at:
+          type: string
+          format: date-time
+          description: The date and time the sponsorship was last updated.
+        funder:
+          "$ref": "#/components/schemas/Account"
+        maintainer:
+          "$ref": "#/components/schemas/Account"