mirror of
https://github.com/hanzo-cpp/sdk.git
synced 2026-11-20 19:55:32 +00:00
The projection these were generated from was a month old and predated the compute migration, so every one of them described /v1/visor — which the API serves at zero paths now. That is why a hand-written console client and a generated one had drifted the same way at the same time. No /v1/visor path survives here. The word still appears as a source-plane value and inside gvisor and supervisor, which are not this rename.
273 lines
10 KiB
C++
273 lines
10 KiB
C++
/**
|
|
* Hanzo Cloud API
|
|
* The Hanzo Cloud API as a customer calls it: every operation under /v1/ except the operator's admin product, relay routes, legacy spellings and capabilities still reached by flag. Tagged by product: the first path segment after /v1/.
|
|
*
|
|
* The version of the OpenAPI document: v1
|
|
*
|
|
* NOTE: This class is auto generated by OpenAPI-Generator 7.14.0.
|
|
* https://openapi-generator.tech
|
|
* Do not edit the class manually.
|
|
*/
|
|
|
|
/*
|
|
* Entry.h
|
|
*
|
|
*
|
|
*/
|
|
|
|
#ifndef HANZO_MODEL_Entry_H_
|
|
#define HANZO_MODEL_Entry_H_
|
|
|
|
#include <boost/optional.hpp>
|
|
|
|
#include "hanzo/ModelBase.h"
|
|
|
|
#include <cpprest/details/basic_types.h>
|
|
|
|
namespace hanzo {
|
|
namespace model {
|
|
|
|
|
|
|
|
class Entry
|
|
: public ModelBase
|
|
{
|
|
public:
|
|
Entry();
|
|
virtual ~Entry();
|
|
|
|
/////////////////////////////////////////////
|
|
/// ModelBase overrides
|
|
|
|
void validate() override;
|
|
|
|
web::json::value toJson() const override;
|
|
bool fromJson(const web::json::value& json) override;
|
|
|
|
void toMultipart(std::shared_ptr<MultipartFormData> multipart, const utility::string_t& namePrefix) const override;
|
|
bool fromMultiPart(std::shared_ptr<MultipartFormData> multipart, const utility::string_t& namePrefix) override;
|
|
|
|
|
|
/////////////////////////////////////////////
|
|
/// Entry members
|
|
|
|
|
|
/// <summary>
|
|
/// Archetype is WHAT KIND OF THING this is, from a closed and ordered list — model | contract | chain | sdk | template | infra | site | app — derived from the repository's own topics, name and description, first match winning, and always `site` for a deployed site. It is DERIVED, never guessed by a model, because a wrong archetype hides a row from the browse rail more thoroughly than a missing one does. Empty when no topic matched: unclassified, not uncategorisable.
|
|
/// </summary>
|
|
utility::string_t getArchetype() const;
|
|
bool archetypeIsSet() const;
|
|
void unsetArchetype();
|
|
void setArchetype(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Description is the repository's own one-line GitHub description, carried verbatim. It comes from the SOURCE half of a row, so a site that was never matched to a repository has none, and nothing here is written by us.
|
|
/// </summary>
|
|
utility::string_t getDescription() const;
|
|
bool descriptionIsSet() const;
|
|
void unsetDescription();
|
|
void setDescription(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Forkable is NOT omitempty: false is an answer here, not a missing field. Omitted, a client could not tell \"you cannot fork this\" from \"nobody said\".
|
|
/// </summary>
|
|
bool isForkable() const;
|
|
bool forkableIsSet() const;
|
|
void unsetForkable();
|
|
void setForkable(bool value);
|
|
|
|
/// <summary>
|
|
/// ID is \"<org>/<name>\" and is the corpus's primary key: a re-published entry updates in place under it rather than accumulating duplicates, so it is the one handle stable enough to link to or to name in a `template` filter. Two orgs can spell the same id, and `canonical` picks which one keeps it.
|
|
/// </summary>
|
|
utility::string_t getId() const;
|
|
bool idIsSet() const;
|
|
void unsetId();
|
|
void setId(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// repo | site
|
|
/// </summary>
|
|
utility::string_t getKind() const;
|
|
bool kindIsSet() const;
|
|
void unsetKind();
|
|
void setKind(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Language is the repository's primary implementation language as GitHub computes it (\"Go\", \"TypeScript\"), and the case is GitHub's. Empty for a site with no source half and for a repository GitHub could not classify.
|
|
/// </summary>
|
|
utility::string_t getLanguage() const;
|
|
bool languageIsSet() const;
|
|
void unsetLanguage();
|
|
void setLanguage(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// License is the terms that upstream work carries, in whichever form the half that credited it had: an SPDX id (\"MIT\", \"Apache-2.0\") on a GitHub fork, free text on a site whose publisher declared it. GitHub's NOASSERTION — \"we could not identify it\" — reads as none rather than as a licence by that name. So empty means UNDECLARED and never unencumbered, and Upstream is what says whether the question applies at all.
|
|
/// </summary>
|
|
utility::string_t getLicense() const;
|
|
bool licenseIsSet() const;
|
|
void unsetLicense();
|
|
void setLicense(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Name is the short identifier inside the org — the repository's name, or the site's slug — and is the half of ID after the slash. Not a display name; Title is.
|
|
/// </summary>
|
|
utility::string_t getName() const;
|
|
bool nameIsSet() const;
|
|
void unsetName();
|
|
void setName(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Note is why a row is NOT in the published catalog, set by the admission gate (gate.go) on the sites it holds back. It is the difference between a demo that silently vanished from the public lens and one whose owner can read the reason and fix it. A published row never carries one.
|
|
/// </summary>
|
|
utility::string_t getNote() const;
|
|
bool noteIsSet() const;
|
|
void unsetNote();
|
|
void setNote(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// hanzo | lux | zoo
|
|
/// </summary>
|
|
utility::string_t getOrg() const;
|
|
bool orgIsSet() const;
|
|
void unsetOrg();
|
|
void setOrg(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Origin is WHAT THIS IS TO YOU: template | community | third-party | product (origin.go owns the four nouns and derives them). Not omitempty, for the same reason Forkable is not: every row has an answer, and a missing one is exactly the flattening this field exists to end.
|
|
/// </summary>
|
|
utility::string_t getOrigin() const;
|
|
bool originIsSet() const;
|
|
void unsetOrigin();
|
|
void setOrigin(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// source
|
|
/// </summary>
|
|
utility::string_t getRepo() const;
|
|
bool repoIsSet() const;
|
|
void unsetRepo();
|
|
void setRepo(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Scope is provenance, not storage: \"public\" for a row from the published corpus, \"org\" for one only this caller can see. A UI that cannot tell them apart cannot warn before sharing a link.
|
|
/// </summary>
|
|
utility::string_t getScope() const;
|
|
bool scopeIsSet() const;
|
|
void unsetScope();
|
|
void setScope(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Stars is GitHub's stargazer count for the source repository, read at the last sync and never accumulated here. It is not a ranking — the page sorts on Updated — but it is the tiebreak when two orgs claim one ID. Absent for a site with no repository behind it, and for a repository nobody has starred.
|
|
/// </summary>
|
|
int64_t getStars() const;
|
|
bool starsIsSet() const;
|
|
void unsetStars();
|
|
void setStars(int64_t value);
|
|
|
|
/// <summary>
|
|
/// lineage, if forked from one
|
|
/// </summary>
|
|
utility::string_t getRTemplate() const;
|
|
bool rTemplateIsSet() const;
|
|
void unsetr_template();
|
|
void setRTemplate(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Title is what to SHOW. A site's human name wins where it has one; a repo row falls back to the repository name, so on a repo this usually just repeats Name. Absent only for a site whose project was never named — render Name.
|
|
/// </summary>
|
|
utility::string_t getTitle() const;
|
|
bool titleIsSet() const;
|
|
void unsetTitle();
|
|
void setTitle(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Updated is when the thing last MOVED, as RFC 3339 in UTC: a repository's last push, or a site's last deploy. The page is ordered on it, most recent first, by comparing these strings — so the format is load-bearing and not cosmetic. Absent means the source reported no timestamp, and such a row sorts last.
|
|
/// </summary>
|
|
utility::string_t getUpdated() const;
|
|
bool updatedIsSet() const;
|
|
void unsetUpdated();
|
|
void setUpdated(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Upstream/License credit the third-party work an entry was published from: the difference between \"this org built it\" and \"somebody else built it and we are showing it to you\". WHO built it is Org, above — the account that paid for the project. There was once a separate admin-gated `official` boolean here claiming the same thing, and because it was gated it disagreed: apps Hanzo wrote and hosts were published by a script holding an ordinary org token, so it stayed false on all of them and this directory filed our own work as somebody else's. A field that restates an unforgeable fact can only ever be the wrong copy of it.
|
|
/// </summary>
|
|
utility::string_t getUpstream() const;
|
|
bool upstreamIsSet() const;
|
|
void unsetUpstream();
|
|
void setUpstream(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// live, if it is deployed
|
|
/// </summary>
|
|
utility::string_t getUrl() const;
|
|
bool urlIsSet() const;
|
|
void unsetUrl();
|
|
void setUrl(const utility::string_t& value);
|
|
|
|
|
|
protected:
|
|
utility::string_t m_Archetype;
|
|
bool m_ArchetypeIsSet;
|
|
|
|
utility::string_t m_Description;
|
|
bool m_DescriptionIsSet;
|
|
|
|
bool m_Forkable;
|
|
bool m_ForkableIsSet;
|
|
|
|
utility::string_t m_Id;
|
|
bool m_IdIsSet;
|
|
|
|
utility::string_t m_Kind;
|
|
bool m_KindIsSet;
|
|
|
|
utility::string_t m_Language;
|
|
bool m_LanguageIsSet;
|
|
|
|
utility::string_t m_License;
|
|
bool m_LicenseIsSet;
|
|
|
|
utility::string_t m_Name;
|
|
bool m_NameIsSet;
|
|
|
|
utility::string_t m_Note;
|
|
bool m_NoteIsSet;
|
|
|
|
utility::string_t m_Org;
|
|
bool m_OrgIsSet;
|
|
|
|
utility::string_t m_Origin;
|
|
bool m_OriginIsSet;
|
|
|
|
utility::string_t m_Repo;
|
|
bool m_RepoIsSet;
|
|
|
|
utility::string_t m_Scope;
|
|
bool m_ScopeIsSet;
|
|
|
|
int64_t m_Stars;
|
|
bool m_StarsIsSet;
|
|
|
|
utility::string_t m_r_template;
|
|
bool m_r_templateIsSet;
|
|
|
|
utility::string_t m_Title;
|
|
bool m_TitleIsSet;
|
|
|
|
utility::string_t m_Updated;
|
|
bool m_UpdatedIsSet;
|
|
|
|
utility::string_t m_Upstream;
|
|
bool m_UpstreamIsSet;
|
|
|
|
utility::string_t m_Url;
|
|
bool m_UrlIsSet;
|
|
|
|
};
|
|
|
|
|
|
}
|
|
}
|
|
|
|
#endif /* HANZO_MODEL_Entry_H_ */
|