{"openapi":"3.1.0","info":{"title":"OiAir Public Read API","version":"1.0.0","description":"Public organizations, search and published group conditions. No private contacts, roster, reservation, payments or request management. Conditions have a source and freshness; published time does not guarantee a place."},"servers":[{"url":"https://oiair.com.br"}],"security":[],"externalDocs":{"description":"API guide","url":"https://oiair.com.br/developers/api/"},"paths":{"/api/v1/search":{"get":{"operationId":"searchActivities","summary":"Search current public organizations and groups","description":"Age, selected days and time must match the same published group. Results are a bounded shortlist; do not treat the count as exhaustive or availability as confirmed.","parameters":[{"name":"q","in":"query","schema":{"type":"string","maxLength":500},"description":"Activity or group query. Do not include personal data."},{"name":"locale","in":"query","schema":{"type":"string","enum":["pt-BR","ru","en","es"],"default":"pt-BR"}},{"name":"city","in":"query","schema":{"type":"string","maxLength":120}},{"name":"neighborhood","in":"query","schema":{"type":"string","maxLength":120}},{"name":"age","in":"query","schema":{"type":"integer","minimum":0,"maximum":18}},{"name":"days","in":"query","schema":{"type":"string"},"description":"Comma-separated weekday numbers, 0=Sunday, 6=Saturday. Any selected day may match."},{"name":"period","in":"query","schema":{"type":"string","enum":["manha","tarde","noite"]},"description":"Morning, afternoon or evening respectively."},{"name":"after17","in":"query","schema":{"type":"boolean"},"description":"Require a published group starting at or after 17:00 in its local timezone."},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":50,"default":20}},{"name":"cursor","in":"query","schema":{"type":"string"},"description":"Opaque cursor from the same query, filters and locale."}],"responses":{"200":{"description":"Current public data. Availability is not a reservation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResult"}}}},"400":{"description":"Invalid input.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Organization or current publication unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Search generation or cursor changed. Restart the search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"Search cursor expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Current source unavailable. Do not invent a successful result.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/catalog":{"get":{"operationId":"listOrganizations","summary":"Browse the current public catalog","parameters":[{"name":"locale","in":"query","schema":{"type":"string","enum":["pt-BR","ru","en","es"],"default":"pt-BR"}},{"name":"q","in":"query","schema":{"type":"string","maxLength":160}},{"name":"city","in":"query","schema":{"type":"string","maxLength":100}},{"name":"age","in":"query","schema":{"type":"integer","minimum":0,"maximum":18}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":50,"default":20}},{"name":"cursor","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Current public data. Availability is not a reservation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogResult"}}}},"400":{"description":"Invalid input.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Organization or current publication unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Search generation or cursor changed. Restart the search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"Search cursor expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Current source unavailable. Do not invent a successful result.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/organizations/{organizationId}":{"get":{"operationId":"getOrganization","summary":"Read a current organization and its published groups","parameters":[{"name":"organizationId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"locale","in":"query","schema":{"type":"string","enum":["pt-BR","ru","en","es"],"default":"pt-BR"}}],"responses":{"200":{"description":"Current public data. Availability is not a reservation.","content":{"application/json":{"schema":{"type":"object","required":["item","syncedAt"],"properties":{"item":{"$ref":"#/components/schemas/Organization"},"revision":{"type":"integer"},"syncedAt":{"type":"string","format":"date-time"}},"additionalProperties":true}}}},"400":{"description":"Invalid input.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Organization or current publication unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Search generation or cursor changed. Restart the search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"Search cursor expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Current source unavailable. Do not invent a successful result.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/offerings":{"get":{"operationId":"listOfferings","summary":"Read current published offerings","parameters":[{"name":"organizationId","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"age","in":"query","schema":{"type":"integer","minimum":0,"maximum":18}},{"name":"city","in":"query","schema":{"type":"string","maxLength":160}},{"name":"text","in":"query","schema":{"type":"string","maxLength":160}},{"name":"after","in":"query","schema":{"type":"string","format":"uuid"},"description":"Opaque continuation ID from next. A page contains at most 50 publications."}],"responses":{"200":{"description":"Current public data. Availability is not a reservation.","content":{"application/json":{"schema":{"type":"object","required":["items","next"],"properties":{"items":{"type":"array","maxItems":50,"items":{"$ref":"#/components/schemas/Offering"}},"next":{"type":["string","null"]}},"additionalProperties":false}}}},"400":{"description":"Invalid input.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Organization or current publication unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Search generation or cursor changed. Restart the search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"Search cursor expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Current source unavailable. Do not invent a successful result.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/offerings/{publicationId}":{"get":{"operationId":"getOffering","summary":"Read one current publication","description":"Read and retain its exact version before choosing a group. Withdrawn or expired publications are unavailable.","parameters":[{"name":"publicationId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Current public data. Availability is not a reservation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Offering"}}}},"400":{"description":"Invalid input.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Organization or current publication unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Search generation or cursor changed. Restart the search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"Search cursor expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Current source unavailable. Do not invent a successful result.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/activity-types":{"get":{"operationId":"listActivityTypes","summary":"Read activity types with current public organizations","parameters":[{"name":"locale","in":"query","schema":{"type":"string","enum":["pt-BR","ru","en","es"],"default":"pt-BR"}},{"name":"city","in":"query","schema":{"type":"string","maxLength":100}}],"responses":{"200":{"description":"Current public data. Availability is not a reservation.","content":{"application/json":{"schema":{"type":"object","required":["activityTypes","validUntil"],"properties":{"activityTypes":{"type":"array","items":{"type":"object","additionalProperties":true}},"validUntil":{"type":"string","format":"date-time"}},"additionalProperties":true}}}},"400":{"description":"Invalid input.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Organization or current publication unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Search generation or cursor changed. Restart the search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"Search cursor expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Current source unavailable. Do not invent a successful result.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"schemas":{"Error":{"type":"object","required":["error"],"properties":{"error":{"type":"string"}},"additionalProperties":false},"Freshness":{"type":"object","required":["source","checkedAt","validUntil"],"properties":{"source":{"type":"string"},"checkedAt":{"type":"string","format":"date-time"},"validUntil":{"type":"string","format":"date-time"}},"additionalProperties":false},"Organization":{"type":"object","required":["id","organization"],"properties":{"id":{"type":"string","format":"uuid"},"organization":{"type":"string"},"profileSlug":{"type":["string","null"]},"publishedOffers":{"type":"array","items":{"type":"object","additionalProperties":true}}},"additionalProperties":true},"Offering":{"type":"object","required":["id","organizationId","version","freshness"],"properties":{"id":{"type":"string","format":"uuid"},"organizationId":{"type":"string","format":"uuid"},"version":{"type":"integer","minimum":1},"title":{"type":"string"},"ageMinYears":{"type":"integer"},"ageMaxYears":{"type":"integer"},"timezone":{"type":"string"},"schedule":{"type":"object","additionalProperties":true},"availability":{"type":"string"},"freshness":{"$ref":"#/components/schemas/Freshness"}},"additionalProperties":true},"CatalogResult":{"type":"object","required":["items","syncedAt"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Organization"}},"syncedAt":{"type":"string","format":"date-time"},"nextCursor":{"type":["string","null"]}},"additionalProperties":true},"SearchResult":{"type":"object","required":["items","appliedFilters","queryStatus","hasMore","nextCursor"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Organization"}},"appliedFilters":{"type":"object","additionalProperties":true},"queryStatus":{"type":"string"},"hasMore":{"type":"boolean"},"nextCursor":{"type":["string","null"]},"degraded":{"type":"boolean"},"resultScope":{"type":"string"},"validUntil":{"type":["string","null"],"format":"date-time"}},"additionalProperties":true}}}}