chore: rename the OAS file and repository links to open-catalog-api

.github/workflows/spectral.yaml

@@ -29,7 +29,7 @@ jobs:
       - uses: bfabio/spectral-action@5af95a6a2985901bd5e689c663b4f93c660f0d2c
         id: lint
         with:
-          file_glob: software-catalog-api.oas.yaml
+          file_glob: open-catalog-api.oas.yaml
           spectral_ruleset: .spectral.yml
           repo_token: ${{ secrets.GITHUB_TOKEN }}
 

README.md

@@ -1,17 +1,17 @@
 <!-- markdownlint-disable no-inline-html -->
 
-<h1 align="center">Software Catalog API</h1>
+<h1 align="center">Open Catalog API</h1>
 
 <p align="center">
-  <img width="200" src=".github/logo.png" alt="software-catalog-api logo">
+  <img width="200" src=".github/logo.png" alt="open-catalog-api logo">
 </p>
 
 <p align="center">
   <a href="https://www.bestpractices.dev/projects/14158">
     <img src="https://www.bestpractices.dev/projects/14158/badge">
   </a> 
 
-  <img alt="License" src="https://img.shields.io/github/license/italia/developers-italia-api?color=brightgreen">
+  <img alt="License" src="https://img.shields.io/github/license/italia/open-catalog-api?color=brightgreen">
 </p>
 
 <div align="center">
@@ -23,7 +23,7 @@
 </div>
 
 <p align="center">
-  <strong>Software Catalog API</strong> is a RESTful API for public software catalogs.
+  <strong>Open Catalog API</strong> is a RESTful API for public software catalogs.
   It powers national open source catalogs for public administrations:
 </p>
 
@@ -64,7 +64,7 @@ You can configure the API with environment variables:
   and a token with the built-in subcommand:
 
   ```console
-  developers-italia-api token create
+  open-catalog-api token create
   ```
 
   Pass `--key` to use an existing key, `--sub` to identify the caller,
@@ -85,9 +85,9 @@ You can configure the API with environment variables:
 This project exists also thanks to your contributions! Here is a list of people
 who already contributed to this repository:
 
-<a href="https://github.com/italia/developers-italia-api/graphs/contributors">
+<a href="https://github.com/italia/open-catalog-api/graphs/contributors">
   <img
-  src="https://contributors-img.web.app/image?repo=italia/developers-italia-api"
+  src="https://contributors-img.web.app/image?repo=italia/open-catalog-api"
   />
 </a>
 

SECURITY.md

@@ -13,7 +13,7 @@ patched, so upgrade to the latest tag before reporting a problem.
 ## Reporting a vulnerability
 
 Report security vulnerabilities via [GitHub private vulnerability
-reporting](https://github.com/italia/developers-italia-api/security/advisories/new).
+reporting](https://github.com/italia/open-catalog-api/security/advisories/new).
 The report stays private between you and the maintainers until a fix is
 released.
 

software-catalog-api.oas.yaml → open-catalog-api.oas.yaml

@@ -1,8 +1,8 @@
 openapi: 3.0.0
 info:
-  title: Software Catalog API
+  title: Open Catalog API
   version: 1.0.0
-  x-summary: Software Catalog API
+  x-summary: Open Catalog API
   description: |
     REST API for public software catalogs.
 
@@ -736,7 +736,7 @@
           in: query
           name: to
           description: Only logs before this time (RFC 3339 datetime)
         - schema:
             type: string
             maxLength: 255
             example: 'BAD publiccode'
@@ -2012,7 +2012,7 @@
           schema:
             $ref: '#/components/schemas/Error'
   schemas:
     AnalysisData:
       title: AnalysisData
       type: object
       nullable: true
@@ -2039,7 +2039,7 @@
             readOnly: true
             description: Timestamp of the last write (RFC 3339 datetime).
             example: '2024-01-15T10:30:00Z'
         additionalProperties: true
       example:
         acme-security-scanner:
           v: 1
@@ -2083,7 +2083,7 @@
               - remove
               - replace
               - test
           path:
             type: string
             maxLength: 255
             description: >
@@ -2094,7 +2094,7 @@
           value:
             description: The value to set. Required for add, replace, and test operations.
             example: 'name: My Software'
           from:
             type: string
             maxLength: 255
             description: Source JSON Pointer, used by move and copy operations.
@@ -2202,13 +2202,13 @@
           description: Unique identifier of the Catalog
           example: 'a1b2c3d4-e5f6-4789-abcd-ef0123456789'
           readOnly: true
         name:
           type: string
           minLength: 1
           maxLength: 255
           description: Human-readable name of the catalog
           example: 'Public Software Catalog'
         alternativeId:
           type: string
           description: >
             Optional alternative user-provided identifier for this Catalog.
@@ -2225,7 +2225,7 @@
           description: Whether this Catalog is active or not
           default: true
           example: true
         publishersNamespace:
           type: string
           maxLength: 255
           description: >
@@ -2234,7 +2234,7 @@
             each publiccode.yml organisation field equals
             this prefix + the publisher alternativeId.
           example: 'urn:x-italian-pa:'
         scopes:
           type: array
           maxItems: 20
           description: >
@@ -2247,7 +2247,7 @@
             string up to 64 characters is accepted. An empty or
             absent list means the catalog is thematic and not tied
             to a specific place.
           items:
             type: string
             minLength: 1
             maxLength: 64
@@ -2255,7 +2255,7 @@
           example:
             - 'iso3166:IT'
             - 'm49:150'
         sources:
           type: array
           maxItems: 100
           description: >
@@ -2290,7 +2290,7 @@
       type: object
       additionalProperties: false
       properties:
         driver:
           type: string
           maxLength: 64
           description: >
@@ -2310,7 +2310,7 @@
             Optional arguments for the driver (e.g. a JSON
             configuration file URL).
           example: ['https://example.org/config.json']
           items:
             type: string
             minLength: 1
             maxLength: 2048
@@ -2627,7 +2627,7 @@
           maxLength: 255
           example: 'https://example.org/my-webhook-endpoint'
           description: URL where the webhook payload will be delivered to
         secret:
           type: string
           minLength: 16
           maxLength: 256

publiccode.yml

@@ -15,7 +15,7 @@ description:
       - Containerization support
       - Helm chart available
     longDescription: |
-      **software-catalog-api** is a RESTful API for public software catalogs.
+      **open-catalog-api** is a RESTful API for public software catalogs.
       It powers developers.italia.it and can be deployed as a standalone
       instance for any public software catalog.
     shortDescription: |-
@@ -46,7 +46,7 @@ maintenance:
   contacts:
     - name: Fabio Bonelli
   type: community
-name: software-catalog-api
+name: open-catalog-api
 platforms:
   - web
 dependsOn:
@@ -55,4 +55,4 @@ dependsOn:
       optional: true
 softwareType: standalone/backend
 softwareVersion: v1.0.0
-url: "https://github.com/italia/developers-italia-api"
+url: "https://github.com/italia/open-catalog-api"