@common-grants/core 0.1.0-alpha.10 → 0.1.0-alpha.12

package/README.md

@@ -101,9 +101,7 @@ import "./routes.tsp"; // Import the routes from above
 using TypeSpec.Http;
 
 /** Description of your API goes here */
-@service({
-  title: "Custom API",
-})
+@service(#{ title: "Custom API" })
 namespace CustomAPI;
 ```
 

package/lib/api.tsp

@@ -5,15 +5,26 @@ import "@typespec/openapi";
 
 using TypeSpec.Http;
 using TypeSpec.OpenAPI;
-
 /** The base OpenAPI specification for a CommonGrants API
  *
  * In order for an API to be "compliant" with the CommonGrants protocol,
  * it must implement all of the routes with the "required" tag in this specification.
  */
-@service({
-  title: "CommonGrants Base API",
-})
+@service(#{ title: "CommonGrants Base API" })
+@tagMetadata(
+  "Opportunities",
+  #{ description: "Endpoints related to funding opportunities" }
+)
+@tagMetadata(
+  "required",
+  #{
+    description: "Endpoints that MUST be implemented by all CommonGrants APIs",
+  }
+)
+@tagMetadata(
+  "optional",
+  #{ description: "Endpoints that MAY be implemented by CommonGrants APIs" }
+)
 namespace CommonGrants.API;
 
 @tag("Opportunities")

package/lib/core/fields/index.tsp

@@ -3,6 +3,8 @@ import "./metadata.tsp";
 import "./money.tsp";
 import "./event.tsp";
 
+using TypeSpec.JsonSchema;
+
 /** A standard set of fields, e.g. `money` that can be reused across models
  *
  * @example How to use the `Fields` namespace
@@ -17,4 +19,5 @@ import "./event.tsp";
  * }
  * ```
  */
+@jsonSchema
 namespace CommonGrants.Fields;

package/lib/core/filters/base.tsp

@@ -71,6 +71,7 @@ enum AllOperators {
 model DefaultFilter {
   /** The operator to apply to the filter value */
   operator:
+    | EquivalenceOperators
     | ComparisonOperators
     | ArrayOperators
     | StringOperators

package/lib/core/filters/index.tsp

@@ -4,6 +4,8 @@ import "./numeric.tsp";
 import "./money.tsp";
 import "./string.tsp";
 
+using TypeSpec.JsonSchema;
+
 /** A standard set of filters, e.g. `StringArrayFilter`, that can be reused across models
  *
  * @example How to use the `Filters` namespace
@@ -34,4 +36,5 @@ import "./string.tsp";
  * }
  * ```
  */
+@jsonSchema
 namespace CommonGrants.Filters;

package/lib/core/pagination.tsp

@@ -1,8 +1,9 @@
 import "@typespec/http";
 
 using TypeSpec.Http;
-
+using TypeSpec.JsonSchema;
 /** Models and utilities for pagination */
+@jsonSchema
 namespace CommonGrants.Pagination;
 
 /** Query parameters for paginated routes */

package/lib/core/responses/index.tsp

@@ -3,6 +3,8 @@ import "@typespec/http";
 import "./error.tsp";
 import "./success.tsp";
 
+using TypeSpec.JsonSchema;
+
 /** A standardized set of response schemas for CommonGrants API routes
  *
  * @example How to use the `Responses` namespace
@@ -21,4 +23,5 @@ import "./success.tsp";
  * }
  * ```
  */
+@jsonSchema
 namespace CommonGrants.Responses;

package/lib/core/routes/opportunities.tsp

@@ -49,7 +49,7 @@ interface Opportunities {
   @list
   list<T extends Models.OpportunityBase = Models.OpportunityBase>(
     ...Pagination.PaginatedQueryParams,
-  ): Responses.Paginated<T> | Responses.Unauthorized;
+  ): Responses.Paginated<T>;
 
   // ##############################
   // View an opportunity
@@ -66,7 +66,7 @@ interface Opportunities {
   read<T extends Models.OpportunityBase = Models.OpportunityBase>(
     /** The ID of the opportunity to view */
     @path id: Types.uuid,
-  ): Responses.Ok<T> | Responses.NotFound | Responses.Unauthorized;
+  ): Responses.Ok<T> | Responses.NotFound;
 
   // ###############################
   // Search opportunities
@@ -94,5 +94,5 @@ interface Opportunities {
 
     /** Pagination instructions for the results */
     pagination?: Pagination.PaginatedBodyParams,
-  ): Responses.Filtered<T, Models.OppFilters> | Responses.Unauthorized;
+  ): Responses.Filtered<T, Models.OppFilters>;
 }

package/lib/core/sorting.tsp

@@ -1,7 +1,7 @@
 import "@typespec/http";
 
 using TypeSpec.Http;
-
+using TypeSpec.JsonSchema;
 /** Models for sorting
  *
  * @example How to use the `Sorting` namespace
@@ -15,6 +15,7 @@ using TypeSpec.Http;
  * op list(sorting: Sorting.SortQueryParams): Responses.Sorted<MyModel>;
  * ```
  */
+@jsonSchema
 namespace CommonGrants.Sorting;
 
 enum SortOrder {
@@ -27,7 +28,7 @@ model SortQueryParams {
   /** The field to sort by */
   @query
   @example("lastModifiedAt")
-  sortBy: string;
+  sortBy: unknown;
 
   /** Implementation-defined sort key */
   @query

package/lib/core/types.tsp

@@ -1,3 +1,5 @@
+using TypeSpec.JsonSchema;
+
 /** A collection of base data types used throughout the CommonGrants API
  *
  * @example How to use the `Types` namespace
@@ -16,6 +18,7 @@
  * }
  * ```
  */
+@jsonSchema
 namespace CommonGrants.Types;
 
 /** A time on a clock, without a timezone, in ISO 8601 format HH:mm:ss */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@common-grants/core",
-  "version": "0.1.0-alpha.10",
+  "version": "0.1.0-alpha.12",
   "description": "TypeSpec library for defining grant opportunity data models and APIs",
   "type": "module",
   "main": "dist/src/index.js",
@@ -55,11 +55,11 @@
   "author": "CommonGrants",
   "license": "CC0-1.0",
   "peerDependencies": {
-    "@typespec/compiler": "^0.63.0",
-    "@typespec/http": "^0.63.0",
-    "@typespec/json-schema": "^0.63.0",
-    "@typespec/openapi3": "^0.63.0",
-    "@typespec/rest": "^0.63.0"
+    "@typespec/compiler": "^0.66.0",
+    "@typespec/http": "^0.66.0",
+    "@typespec/json-schema": "^0.66.0",
+    "@typespec/openapi3": "^0.66.0",
+    "@typespec/rest": "^0.66.0"
   },
   "devDependencies": {
     "@types/node": "^20.10.6",