Skip to content

Commit 7866398

Browse files
- Updated documentation.
1 parent c72b5c6 commit 7866398

12 files changed

+1950
-1158
lines changed

AGENTS.md

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,18 @@ A formal definition must be supplied.
5555

5656
## 3. Global Invariants
5757

58-
### 3.1 Operation Identity
58+
### 3.1 Document Schemas
59+
60+
As mentioned above, the root document for each provider is `provider.yaml`; the expected schema is mastered at [`cicd/schema-definitions/provider.schema.json`](/cicd/schema-definitions/provider.schema.json).
61+
62+
For each service document referenced from this root, the schema varies on provider `protocolType`:
63+
64+
- `http` => [`cicd/schema-definitions/service-resources.schema.json`](/cicd/schema-definitions/service-resources.schema.json).
65+
- `local_templated` => [`cicd/schema-definitions/local-templated.service-resources.schema.json`](/cicd/schema-definitions/local-templated.service-resources.schema.json).
66+
67+
There is also support for spliting service and resource files, although this is rarely used. The schema for such a split out resource file is visible at [`cicd/schema-definitions/fragmented-resources.schema.json`](/cicd/schema-definitions/fragmented-resources.schema.json).
68+
69+
### 3.2 Operation Identity
5970

6071
Each operation must be routable through:
6172

@@ -77,48 +88,49 @@ Methods mapped to SQL verbs are annotated in an `sqlVerbs` dictionary, which all
7788

7889
---
7990

80-
### 3.2 HTTP Semantics
91+
### 3.3 HTTP Semantics
8192
_TBA._
8293

8394
---
8495

85-
### 3.3 Authentication
96+
### 3.4 Authentication
8697
_TBA._
8798
This is yet to be formally defined. OAuth, simple key-based authentication, and various environment-variable-based patterns are supported.
8899
Unauthenticated systems should be explicitly designated as having `null` auth.
89100

90101
---
91102

92-
### 3.4 Pagination
103+
### 3.5 Pagination
93104
Opt-in, with default behavior. _TBA._
94105

95106
---
96107

97-
### 3.5 Errors
108+
### 3.6 Errors
98109
Canonically aligned with `openapi3`.
99110

100111
---
101112

102-
### 3.6 Rate Limiting
113+
### 3.7 Rate Limiting
103114
Modeled as a class of failure within a broader collection of possible failure classes, including network and system failures.
104115

105116
---
106117

107-
### 3.7 Long-Running Operations (LRO)
118+
### 3.8 Long-Running Operations (LRO)
108119
If an operation is asynchronous:
109120
- Different providers have different polling or notification methods.
110121
- Initially, behavior similar to Google’s `Operation` polling is supported.
111122

112123
---
113124

114-
### 3.8 OS / Non-HTTP Transports
125+
### 3.9 OS / Non-HTTP Transports
115126
_TBA._
116127
See the `local_openssl` provider for an example.
117128

118129
---
119130

120131
## 4. Validation Rules
121-
These are informally enforced through the `any-sdk` CLI, specifically the `aot` command.
132+
133+
These are informally enforced through the `any-sdk` CLI, specifically the `aot` command. This includes various configuration options.
122134

123135
---
124136

cicd/any-sdk-schemas-2a/README.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

cicd/any-sdk-schemas-2a/fragmented-resources.schema.json

Lines changed: 0 additions & 275 deletions
This file was deleted.

0 commit comments

Comments
 (0)